Scenario #1103: Replace Contact Data

Properties

Required

Given

name value
partnerName Test AG
newContactCaption Test AG - China
newPostalAddress          “department”: “Executive Board”,
         “building”: “Thi Chi Koh Building”,
         “street”: “No.2 Commercial Second Street”,
         “district”: “Niushan Wei Wu”,
         “city”: “Dongguan City”,
         “province”: “Guangdong Province”,
         “country”: “China”
newOfficePhoneNumber ++15 999 654321
newEmailAddress norden@test-ag.example.org

partnerRelationUuid

HTTP GET "/api/hs/office/relations?relationType=PARTNER&personData=Test+AG" \
  -H "Authorization: Bearer $HSADMINNG_JWT_BEARER" \
  `# {` \
  `#   "sub" : "uuid<hsh-alex_superuser>"` \
  `# }`
=> status: 200 OK 
[ {
  "uuid" : "f1943189-716b-46ea-8218-fa169740db15",
  "anchor" : {
    "uuid" : "806e75fe-7894-4422-86be-783107f07f3f", // Person: Hostsharing eG
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Hostsharing eG",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "00ddd2fc-8742-46e5-924c-77749d4c8ccc", // Person: Test AG
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Test AG",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "type" : "PARTNER",
  "mark" : null,
  "contact" : {
    "uuid" : "781f566a-af3e-4e71-9411-b6a0fbfa317e", // Contact: Test AG - Hamburg
    "caption" : "Test AG - Hamburg",
    "postalAddress" : {
      "zipcode" : "20123",
      "firm" : "Test AG",
      "country" : "Germany",
      "city" : "Hamburg",
      "street" : "Shanghai-Allee 1",
      "department" : "Geschäftsleitung"
    },
    "emailAddresses" : {
      "main" : "hamburg@test-ag.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 40 654321-0"
    }
  }
} ]

In production, data this query could result in multiple outputs. In that case, you have to find out which is the right one.

Contact: Test AG - China

HTTP POST "/api/hs/office/contacts" \
  -H "Authorization: Bearer $HSADMINNG_JWT_BEARER" \
  `# {` \
  `#   "sub" : "uuid<hsh-alex_superuser>"` \
  `# }` \
  <<EOF
{
  "caption" : "Test AG - China",
  "postalAddress" : {
    "department" : "Executive Board",
    "building" : "Thi Chi Koh Building",
    "street" : "No.2 Commercial Second Street",
    "district" : "Niushan Wei Wu",
    "city" : "Dongguan City",
    "province" : "Guangdong Province",
    "country" : "China"
  },
  "phoneNumbers" : {
    "phone" : "++15 999 654321"
  },
  "emailAddresses" : {
    "main" : "norden@test-ag.example.org"
  }
}
EOF
=> status: 201 CREATED 351fc296-c0f1-459a-8730-4a65b9605cee

Please check first if that contact already exists, if so, use it’s UUID below.

If any postalAddress sub-properties besides those specified in the API (currently firm, name, co, street, zipcode, city, country) its values might not appear in external systems.

Replace the Contact-Reference in the Partner-Relation

HTTP PATCH "/api/hs/office/relations/f1943189-716b-46ea-8218-fa169740db15" // partnerRelationUuid \
  -H "Authorization: Bearer $HSADMINNG_JWT_BEARER" \
  `# {` \
  `#   "sub" : "uuid<hsh-alex_superuser>"` \
  `# }` \
  <<EOF
{
  "contact.uuid" : "351fc296-c0f1-459a-8730-4a65b9605cee" // Contact: Test AG - China
}
EOF
=> status: 200 OK

Verify if the Contact-Relation Got Replaced in the Partner-Relation

HTTP GET "/api/hs/office/relations?relationType=PARTNER&personData=Test+AG" \
  -H "Authorization: Bearer $HSADMINNG_JWT_BEARER" \
  `# {` \
  `#   "sub" : "uuid<hsh-alex_superuser>"` \
  `# }`
=> status: 200 OK 
[ {
  "uuid" : "f1943189-716b-46ea-8218-fa169740db15", // partnerRelationUuid
  "anchor" : {
    "uuid" : "806e75fe-7894-4422-86be-783107f07f3f", // Person: Hostsharing eG
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Hostsharing eG",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "00ddd2fc-8742-46e5-924c-77749d4c8ccc", // Person: Test AG
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Test AG",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "type" : "PARTNER",
  "mark" : null,
  "contact" : {
    "uuid" : "351fc296-c0f1-459a-8730-4a65b9605cee", // Contact: Test AG - China
    "caption" : "Test AG - China",
    "postalAddress" : {
      "country" : "China",
      "province" : "Guangdong Province",
      "city" : "Dongguan City",
      "street" : "No.2 Commercial Second Street",
      "district" : "Niushan Wei Wu",
      "department" : "Executive Board",
      "building" : "Thi Chi Koh Building"
    },
    "emailAddresses" : {
      "main" : "norden@test-ag.example.org"
    },
    "phoneNumbers" : {
      "phone" : "++15 999 654321"
    }
  }
} ]

generated on 2026-08-10 01:37:52 for branch